Dynagraph Control – Methods

The following table lists and describes methods of the Dynagraph Control. Methods are accessed using the control's script editor.

Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The X method column in the table below indicates whether or not a property or method is accessible using the X method.

The DataGroup parameter referenced in the table below is an integer that identifies a data group instance to operate on. The possible values are:

Note: For advanced details about scripting these methods, see CxDynagraph Methods.

Method X Method Description

AbortAllRequests

No

The AbortAllRequests method aborts all card poll requests. See Aborting Card Requests.

AbortCurrentRequests

No

The AbortCurrentRequest method aborts all current card poll requests. See Aborting Card Requests.

AboutBox

No

The AboutBox method displays an About dialog box for the control.

Syntax

AboutBox()

Example

The following examples launch an About dialog box for the control.

Copy
AboutBox
Sub ShowAboutBox()
 
    <Object>.AboutBox
 
End Sub

Sub ButtonTool_EventClick()

    Dim This : Set This = ButtonTool
    <Object>.AboutBox
 
End Sub

AddCalcMethodFilter

No

The AdCalcMethodFilter method adds a calculation method filter to limit downhole cards based on relevant calculation type(s) used in a single transaction.

CanGetFromRtu

No

CanGetFromRtu returns true if the user can retrieve data from RTU. The user can retrieve data if they have the necessary security credentials. For card data groups, the user must have necessary security credentials and the EIE must support the particular card type.

Syntax

CanGetFromRtu(DataGroup As Integer) As Boolean

Parameters
  • DataGroup parameter can be 0 – 10.
Return Values
  • Return value is true if the user can retrieve data from RTU.

CanSendToRtu

No

CanSendToRtu returns true if the user can send data to RTU. Pumpoff configuration and fluid fill data can be sent if the user has the necessary security credentials and the data has been read from the RTU already. Reference cards can be sent if the EIE supports writing reference cards and the user has the necessary security credentials.

Syntax

CanSendToRtu(DataGroup As Integer) As Boolean

Parameters
  • DataGroup parameter can be 0, 5, or 7.
Return Values
  • Return value is true if the user can send data to RTU.

ChooseFacility

No

The ChooseFilter method displays a Facility Chooser dialog box and returns the selected facilities in an array.

ChooseSiteService

No

The ChooseSiteService method displays a Select Service dialog box to select a UIS Site.Service.

ClearCalcMethodFilters

No

The ClearCalcMethodFilter method clears a calculation method filter. Results in the display of all available card types.

EditCardTraceSetup

No

The EditCardTraceSetup method edits a card trace setup. A trace polls current cards at a specified interval for a specified duration, allowing you to closely monitor a well for a short length of time. See Executing a Card Trace.

EditData

No

EditData presents a dialog to edit pumpoff configuration or fluid fill data parameters and send changes to the RTU.

Syntax

EditDataDataGroup As Integer) As Boolean

Parameters
  • DataGroup parameter can only be 0 or 7.
Return Values
  • Return value is true if the data can be sent to the RTU.

ExportCard

No

The ExportCard method exports the card to a text or data file. See Saving Cards.

ExportCardEx

No

  

GetCardCount

No

The GetCardCount method returns the number of cards of the currently chosen card type that the device has.

GetCardFromRtu

No

GetCardFromRtu issues a poll for the specified DynaCard data group.

Syntax

GetCardFromRtuDataGroup As Integer, NumCards As Integer) As Boolean

Parameters
  • DataGroup parameter can only be 2, 3, 4, 5, 6, 8, 9, or 10.
  • NumCards parameter specifies how many cards to retrieve, can be between 1-5.
Return Values
  • Return value is true if poll is successfully submitted.

GetCardPairFromRtu

No

GetCardPairFromRtu issues a poll for the two specified DynaCard data groups.

Syntax

GetCardPairFromRtu(DataGroup1 As Integer, NumCards1 As Integer, DataGroup2 As Integer, NumCards2 As Integer) As Boolean

Parameter
  • DataGroup1 and DataGroup2 parameters can only be 2, 3, 4, 5, 6, 8, 9, or 10.
  • NumCards1 and NumCards2 parameters specify how many cards to retrieve, can be between 1-5.
Return Values
  • Return value is true if polls are successfully submitted.

GetDeviceType

No

  

GetDownholeCalcMethods

No

  

GetFacilityCount

No

  

GetFromRtu

No

GetFromRtu issues a poll for the specified data group.

Syntax

GetFromRtuDataGroup As Integer) As Boolean

Parameter
  • DataGroup parameter can be 0 - 10.
Return Values
  • Return value is true if poll is successfully submitted.

GetLastRequestError

No

  

GetRequestQueueCount

No

  

GetRequestQueueCurrent

No

  

GetSelectedCardDataElement

No

The GetSelectedCardDataElement method returns the data value for a data element in the DDS transaction of the currently selected card. Deid is the name of the data element requested and if it is an ordinalized data element (like the load and position values are). Index is the ordinal of the data element to retrieve.

GetSelectedCardDbKey

No

The GetSelectedCardDbKey method returns the DDS database key (DbKey) for the currently selected card.

GetSelectedCardToken

No

The GetSelectedCardToken method returns the token for the currently selected card.

GetSelectedCardXml

No

The GetSelectedCardXml method returns the XML for the DDS transaction of the currently selected card.

IsCalcMethodFilter

No

  

IsCardTraceActive

No

The IsCardTraceActive method determines whether the card trace is active or not. See Executing a Card Trace.

IsSelectedCardMostRecent

No

The IsSelectedCardMostRecent method enables a user to call the function to determine whether the selected card is the most recently retrieved card of its type. Boolean value returned.

Navigate

No

The Navigate method chooses the next pump off control device for the UIS if nNavObject is 0, or the next card for the selected device if nNavObject is 1. If bGoForward is True, this will navigate forwards to the next device or the next card, and if bGoForward is False this will navigate backwards to the previous device or previous card. Calling this function causes the CardChange event to fire if the selected device has a card of the set card type.

Print

No

The Print method prints the contents of the control, grid, or viewer. When this method is called, the Print dialog box is shown to allow configuration.

ProcessChanges

No

  

RefreshCards

No

The RefreshCards method enables you to manually refresh card data and display to see the latest changes. Useful when a dynagraph card depends on another system for calculations, which might create a small lag time in communication between the systems.

RefreshConfig

No

The RefreshConfig method refreshes the pumpoff configuration display.

RefreshDataGroup

No

RefreshDataGroup causes the control to re-read the data group data or status points and refresh the visible values.

Syntax

RefreshDataGroup(DataGroup As Integer)

Parameter
  • DataGroup parameter can be 0, 1, or 7.
Return Values
  • This method returns no values.

RefreshStatus

No

The RefreshStatus method refreshes the status data display.

RemoveCalcMethodFilter

No

  

RemoveCard

No

The RemoveCard method removes a card from the view set.

SaveReferenceCard

No

The SaveReferenceCard method displays the Save as Reference Card dialog box, allowing you to save the selected card as the most recent reference card in your CygNet system.

SelectCards

No

  

SendToRtu

No

SendToRtu enables resending of pumpoff configuration or fluid fill data that has already been read from RTU.

Syntax

SendToRtu(DataGroup As Integer) As Boolean

Parameter
  • DataGroup parameter can be 0 or 7.
Return Values
  • Return value is true if the send transaction completed successfully.

SetDynagraph

No

The SetDynagraph method sets the UIS and facility ID for the desired pump off control device. Calling this function causes the CardChange event to fire if the selected device has a card of the set card type.

ShowCardDetails

No

The ShowCardDetails method displays the Dynagraph Card Details dialog box, displaying card information and position/load pairs.

StartCardTrace

No

The StartCardTrace method starts a card trace. See Executing a Card Trace for more information.

ViewDbKey

No

  

Back to top